sort dependencies in `pyproject.toml` #6388

ChannyClaus · 2024-08-21T23:11:47Z

Summary

resolves #6203

Test Plan

added a test fixing the bug described in the issue.

crates/uv-workspace/src/pyproject_mut.rs

ChannyClaus · 2024-08-21T23:17:35Z

fixing CI

ChannyClaus · 2024-08-25T22:44:10Z

crates/uv/tests/edit.rs

+        description = "Add your description here"
+        requires-python = ">=3.12"
+        dependencies = [
+            "yarl",


wanted to test the case where there's an empty line between dependencies (and it being preserved after uv add) but uv add seems to remove it currently - should probably be done as a separate PR?

#6727? not sure if it's worth it, though, since it's strictly just a formatting nit.

Yeah #6727 sounds like a good candidate for a separate PR

ChannyClaus · 2024-08-26T03:30:20Z

crates/uv-workspace/src/pyproject_mut.rs

+            let index = deps
+                .iter()
+                .map(|d| d.as_str().and_then(try_parse_requirement).unwrap())
+                .position(|r| r.name == req.name && r.extras == req.extras)


not 100% sure if it is correct to omit the comparison for marker here

If the deps aren't sorted, we should just insert at the end

konstin · 2024-08-26T09:23:41Z

crates/uv-workspace/src/pyproject_mut.rs

+                .into_iter()
+                .collect::<Vec<_>>()
+                .windows(2)
+                .all(|w| w[0].to_string() <= w[1].to_string());


This should only pass when all values are strings. If they aren't the table is invalid; We could error, but for simplicity here it makes more sense to treat invalid files as unsorted, add our requirement to the end of the list and let it fail later when we try to use the pyproject.toml

crates/uv-workspace/src/pyproject_mut.rs

konstin · 2024-08-26T09:26:28Z

crates/uv-workspace/src/pyproject_mut.rs

+            let index = deps
+                .iter()
+                .map(|d| d.as_str().and_then(try_parse_requirement).unwrap())
+                .position(|r| r.name == req.name && r.extras == req.extras)


If the deps aren't sorted, we should just insert at the end

crates/uv-workspace/src/pyproject_mut.rs

crates/uv/tests/edit.rs

ChannyClaus · 2024-08-27T22:20:25Z

alright i think it's ready for another look @konstin

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [astral-sh/uv](https://github.com/astral-sh/uv) | patch | `0.4.0` -> `0.4.4` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>astral-sh/uv (astral-sh/uv)</summary> ### [`v0.4.4`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#044) [Compare Source](astral-sh/uv@0.4.3...0.4.4) ##### Enhancements - Allow customizing the project environment path with `UV_PROJECT_ENVIRONMENT` ([#6834](astral-sh/uv#6834)) - Warn when `VIRTUAL_ENV` is set but will not be respected in project commands ([#6864](astral-sh/uv#6864)) - Add `--no-hashes` to `uv export` ([#6954](astral-sh/uv#6954)) - Make HTTP headers title case for backward compatibility ([#6887](astral-sh/uv#6887)) - Pin `.python-version` in `uv init` ([#6869](astral-sh/uv#6869)) - Support `file://` URLs for `UV_PYTHON_INSTALL_MIRROR` ([#6950](astral-sh/uv#6950)) - Introduce more docker tags for uv ([#6053](astral-sh/uv#6053)) ##### Bug fixes - Avoid canonicalizing the cache directory ([#6949](astral-sh/uv#6949)) - Show all PyPy versions in `uv python list --all-versions` ([#6917](astral-sh/uv#6917)) - Avoid incorrect `requires-python` marker simplifications ([#6268](astral-sh/uv#6268)) ##### Documentation - Add documentation for `UV_PROJECT_ENVIRONMENT` ([#6987](astral-sh/uv#6987)) - Add optional dependencies section to the lockfile document ([#6982](astral-sh/uv#6982)) - Document use of the `file://` scheme in Python installation mirrors ([#6984](astral-sh/uv#6984)) - Fix outdated references to the help menu documentation in the first steps page ([#6980](astral-sh/uv#6980)) - Show env option in CLI reference documentation ([#6863](astral-sh/uv#6863)) - Add bind mount example to `docker.md` ([#6921](astral-sh/uv#6921)) ### [`v0.4.3`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#043) [Compare Source](astral-sh/uv@0.4.2...0.4.3) ##### Enhancements - Show build backend output when `--verbose` is provided ([#6903](astral-sh/uv#6903)) - Allow `uv sync --frozen --package` without copying member `pyproject.toml` ([#6943](astral-sh/uv#6943)) ##### Bug fixes - Avoid panic with missing temporary directory ([#6929](astral-sh/uv#6929)) - Avoid updating incorrect dependencies for sorted `uv add` ([#6939](astral-sh/uv#6939)) - Use lower-bound semantics for all Python compatibility comparisons ([#6882](astral-sh/uv#6882)) ### [`v0.4.2`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#042) [Compare Source](astral-sh/uv@0.4.1...0.4.2) ##### Enhancements - Adding support for `.pyc` files in `uv run` ([#6886](astral-sh/uv#6886)) - Treat missing `top_level.txt` as non-fatal ([#6881](astral-sh/uv#6881)) ##### Bug fixes - Fix `is_disjoint` check for supported environments ([#6902](astral-sh/uv#6902)) - Remove dangling archives in `uv cache clean ${package}` ([#6915](astral-sh/uv#6915)) - Error when discovered Python is incompatible with `--isolated` workspace ([#6885](astral-sh/uv#6885)) - Warn when discovered Python is incompatible with PEP 723 script ([#6884](astral-sh/uv#6884)) ### [`v0.4.1`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#041) [Compare Source](astral-sh/uv@0.4.0...0.4.1) ##### Enhancements - Add `uv export --format requirements-txt` ([#6778](astral-sh/uv#6778)) - Allow `@` references in `uv tool install --from` ([#6842](astral-sh/uv#6842)) - Normalize version specifiers by sorting ([#6333](astral-sh/uv#6333)) - Respect the user's upper-bound in `requires-python` ([#6824](astral-sh/uv#6824)) - Use Windows registry to discover Python on Windows directly ([#6761](astral-sh/uv#6761)) - Hint at `--no-workspace` in `uv init` failures ([#6815](astral-sh/uv#6815)) - Update to last PyPy releases ([#6784](astral-sh/uv#6784)) ##### Bug fixes - Avoid deadlocks when multiple uv processes lock resources ([#6790](astral-sh/uv#6790)) - Expand tildes when matching against `PATH` ([#6829](astral-sh/uv#6829)) - Fix `uv init --no-project` alias ([#6837](astral-sh/uv#6837)) - Ignore pre-release segments when discovering via `requires-python` ([#6813](astral-sh/uv#6813)) - Support inline optional tables in `uv add` and `uv remove` ([#6787](astral-sh/uv#6787)) - Update default `hello.py` to pass `ruff format` ([#6811](astral-sh/uv#6811)) - Avoid stripping root for user path display ([#6865](astral-sh/uv#6865)) - Error when user-provided environments are disjoint with Python ([#6841](astral-sh/uv#6841)) - Retain alphabetical sorting for `pyproject.toml` in `uv add` operations ([#6388](astral-sh/uv#6388)))) ##### Documentation - Add a link to the multiple index docs in the alternative index guide ([#6826](astral-sh/uv#6826)) - Add docs for inline exclude newer in PEP 723 scripts ([#6831](astral-sh/uv#6831)) - Enumerate available Docker tags ([#6768](astral-sh/uv#6768)) - Omit `[pip]` section from configuration file docs ([#6814](astral-sh/uv#6814)) - Update `project.urls` in `pyproject.toml` ([#6844](astral-sh/uv#6844)) - Add docs for AWS CodeArtifact usage ([#6816](astral-sh/uv#6816)) ##### Other changes </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

ChannyClaus changed the title ~~Sort dependency~~ sort dependencies after uv add Aug 21, 2024

ChannyClaus commented Aug 21, 2024

View reviewed changes

crates/uv-workspace/src/pyproject_mut.rs Outdated Show resolved Hide resolved

ChannyClaus marked this pull request as draft August 21, 2024 23:17

ChannyClaus force-pushed the sort-dependency branch from 951c2da to d3687df Compare August 21, 2024 23:38

ChannyClaus changed the title ~~sort dependencies after uv add~~ sort dependencies in pyproject.toml Aug 22, 2024

ChannyClaus force-pushed the sort-dependency branch from 9a7c5d4 to f71b1fc Compare August 25, 2024 22:42

ChannyClaus commented Aug 25, 2024

View reviewed changes

ChannyClaus force-pushed the sort-dependency branch from 9cc1ea5 to 1bb6223 Compare August 26, 2024 01:41

ChannyClaus marked this pull request as ready for review August 26, 2024 03:28

ChannyClaus commented Aug 26, 2024

View reviewed changes

ChannyClaus requested a review from konstin August 26, 2024 03:30

konstin reviewed Aug 26, 2024

View reviewed changes

crates/uv/tests/edit.rs Outdated Show resolved Hide resolved

zanieb assigned konstin Aug 26, 2024

ChannyClaus added 11 commits August 27, 2024 11:56

fix tests

10426e1

clippy

9c131a5

place the version constraint on the correct index

279f653

fix the test (should be failing)

01ecc17

index fix + need to fix more tests

7e3291e

fix add_update_marker

c80112a

compare both name and extras

b98054f

move 'sorted' into the conditional since it's only used inside

1217cc6

remove unnecessary assignment

acaf703

omit syncing in the tests

f454d23

add itertools to uv-workspace

2659dc7

ChannyClaus force-pushed the sort-dependency branch from 70b3c77 to 2659dc7 Compare August 27, 2024 15:56

ChannyClaus added 3 commits August 27, 2024 12:24

need to fix reformatting

9934544

handle the indentation edge case

fe7fbfe

add check for str

e1e55f9

ChannyClaus added 2 commits August 27, 2024 18:06

clippy

7f33e71

fix typo

4e3031d

konstin added 2 commits August 29, 2024 16:03

Don't lock on sortedness tests

db2af85

Simplify sorting logic

c27bf33

konstin approved these changes Aug 29, 2024

View reviewed changes

merge main

ae86833

konstin merged commit 4f5356e into astral-sh:main Aug 29, 2024
57 checks passed

BrewTestBot mentioned this pull request Aug 30, 2024

uv 0.4.1 Homebrew/homebrew-core#182978

Merged

charliermarsh mentioned this pull request Sep 2, 2024

uv add confuses dependency versions when installing multiple libraries #6933

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

sort dependencies in `pyproject.toml` #6388

sort dependencies in `pyproject.toml` #6388

ChannyClaus commented Aug 21, 2024

ChannyClaus commented Aug 21, 2024

ChannyClaus Aug 25, 2024

ChannyClaus Aug 27, 2024

konstin Aug 29, 2024

ChannyClaus Aug 26, 2024

konstin Aug 26, 2024

konstin Aug 26, 2024

konstin Aug 26, 2024

ChannyClaus commented Aug 27, 2024

sort dependencies in pyproject.toml #6388

sort dependencies in pyproject.toml #6388

Conversation

ChannyClaus commented Aug 21, 2024

Summary

Test Plan

ChannyClaus commented Aug 21, 2024

ChannyClaus Aug 25, 2024

Choose a reason for hiding this comment

ChannyClaus Aug 27, 2024

Choose a reason for hiding this comment

konstin Aug 29, 2024

Choose a reason for hiding this comment

ChannyClaus Aug 26, 2024

Choose a reason for hiding this comment

konstin Aug 26, 2024

Choose a reason for hiding this comment

konstin Aug 26, 2024

Choose a reason for hiding this comment

konstin Aug 26, 2024

Choose a reason for hiding this comment

ChannyClaus commented Aug 27, 2024

sort dependencies in `pyproject.toml` #6388

sort dependencies in `pyproject.toml` #6388